Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Jump to bottom

Adding Groups and Categories to Organize SDK #546

Open
wants to merge 7 commits into
base: main
Choose a base branch
from
Open

Adding Groups and Categories to Organize SDK #546

wants to merge 7 commits into from
+2,238 −33

Conversation

DavidRollins
Copy link

@DavidRollins DavidRollins commented Oct 17, 2024 •
edited
Loading

Description

This PR will organize the types, enums, functions, variables, classes into either Client (classes which the client calls to use Aptos resources) and Implementation (The details of the internals of said resources), there is also a "Modules->PrivateCode" that provides the internal resources which are not client-facing. Those are available and viewable so the @mixin tagging functions properly.

This will neatly organize the UI to look like the attached images.

Here, you can see the implementation organization for providing users the context of the provided resources.
Image 10-17-24 at 2 37 PM

Here, you can see the neat stacking of Client, Implementation, and Module folders.
Image 10-17-24 at 2 39 PM

Here, you can see the organization of the methods callable via "Aptos" - organized so that the user can select here or in the sidebar.
image

Test Plan

Extensive manual review
Automatic linting

Related Links

Checklist

  • Have you ran pnpm fmt?

@DavidRollins DavidRollins requested a review from a team as a code owner October 17, 2024 19:36
@jmintuitive
Copy link
Contributor

Now that we've merged in the main docs revisions, this is a follow up to add the folder structure to the typedoc :)

We split these into separate PRs since this one is conceptually very simple (just add @category and @group tags into the proper folder structure) - so didn't want to further clutter things in the other (already massive) PR.

For context, @category = big folder and @group = small folder.
On the Aptos class itself, @group is how the methods are grouped into categories like "ANS", "Account", "Coin", etc.

@gregnazario Would it be better for us to merge this in, then generate the docs later - or to include generated docs as part of this PR?

@gregnazario
Copy link
Collaborator

Now that we've merged in the main docs revisions, this is a follow up to add the folder structure to the typedoc :)

We split these into separate PRs since this one is conceptually very simple (just add @category and @group tags into the proper folder structure) - so didn't want to further clutter things in the other (already massive) PR.

For context, @category = big folder and @group = small folder. On the Aptos class itself, @group is how the methods are grouped into categories like "ANS", "Account", "Coin", etc.

@gregnazario Would it be better for us to merge this in, then generate the docs later - or to include generated docs as part of this PR?

Let's get this in now, (I merged in another one your PRs that might have conflicted)

@jmintuitive
Copy link
Contributor

Ok, I'll fix the merge conflicts here tomorrow

Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Reviewers

@gregnazario gregnazario gregnazario approved these changes

At least 2 approving reviews are required to merge this pull request.

Assignees
No one assigned
Labels
None yet
Projects
None yet
Milestone
No milestone
Development

Successfully merging this pull request may close these issues.
3 participants
@DavidRollins @jmintuitive @gregnazario